Encompasses all API of component NilkinsWinUi. More...
Classes | |
class | Button |
A graphical button. More... | |
struct | ChangeEventData |
Data holder for a change event. More... | |
class | CheckBox |
A graphical check box. More... | |
struct | ClickEventData |
Data holder for a click event. More... | |
class | Color |
Represents a color. More... | |
class | ComboBox |
A graphical combo box. More... | |
class | Component |
Base class for any graphical component. More... | |
class | ComponentManager |
Manages the components within nkWinUi. More... | |
class | ContentLoader |
Allows to export and import content through their declaration files. More... | |
class | ContextMenu |
A graphical context menu. More... | |
class | Cursor |
WIP. More... | |
class | CursorManager |
WIP. More... | |
class | EditBox |
A graphical single line edit box. More... | |
class | FileExplorer |
A graphical file explorer. More... | |
class | FontManager |
WIP. More... | |
class | GraphicsWindow |
A graphical window made to receive 3d rendering contexts. More... | |
class | GridLayout |
Implements a layout organizing children components in a grid. More... | |
class | GroupBox |
A graphical group box. More... | |
struct | HandledEventData |
Data holder for a handled event. More... | |
class | InputSystem |
Input system, centralizing default behaviour for the input. More... | |
struct | KeyEventData |
Data holder for a key event. More... | |
class | Layout |
Represents a layout to organize sub-windows in a window. More... | |
class | ListBox |
A graphical list box. More... | |
class | LogManager |
Responsible for logging all messages from the component. More... | |
class | LogWin |
A graphical logging window. More... | |
class | MainSystem |
The main system of the component. More... | |
class | MenuBar |
A graphical menu bar, appended on top of windows. More... | |
struct | MouseMoveEventData |
Data holder for a mouse move event. More... | |
class | MultiLineEdit |
A graphical multi line edit box. More... | |
class | Popup |
A graphical popup window. More... | |
class | ProgressBar |
WIP. More... | |
class | RelativeLayout |
Implements a layout positioning its children components relative to each other. More... | |
class | ScrollBar |
A graphical scroll bar. More... | |
class | Slider |
WIP. More... | |
class | Static |
A graphical static text zone. More... | |
class | StructToString |
Offers utilities to convert from structures or enums to strings, and vice versa. More... | |
class | TabWindow |
A graphical tab window. More... | |
class | Theme |
A theme used to style the windows in the component. More... | |
struct | ThemeColors |
Information about all the colors a theme will need. More... | |
class | ThemeManager |
Manages the themes within the component. More... | |
class | TreeView |
A graphical tree view window. More... | |
struct | WheelEventData |
Data holder for a wheel event. More... | |
class | Window |
A graphical window. More... | |
Typedefs | |
using | mouseMoveCallback = std::function< bool(Component *caller, int absX, int absY, int relX, int relY, int moveX, int moveY)> |
Used by components for a mouse moved event. More... | |
using | mouseClickCallback = std::function< bool(Component *caller, const ClickEventData &eventData)> |
Used by components for a mouse click event. More... | |
using | mouseLeaveCallback = std::function< bool(Component *caller, const nkMaths::Point &absCoords)> |
Used by components when the mouse leaves their area. More... | |
using | keyDownCallback = std::function< bool(Component *caller, KEY_CODE keyCode, bool autoRepeated)> |
Used by component when a keyboard key is pressed down. More... | |
using | keyUpCallback = std::function< bool(Component *caller, KEY_CODE keyCode)> |
Used by component when a keyboard key is released. More... | |
using | menuBarCallback = std::function< bool(Component *caller, int index)> |
Used by a nkWinUi::MenuBar to signal an item has been clicked. More... | |
using | buttonClickCallback = std::function< bool(Button *caller)> |
Used by a nkWinUi::Button to signal it has been clicked. More... | |
using | checkBoxCallback = std::function< bool(CheckBox *caller)> |
Used by a nkWinUi::CheckBox to signal it has been checked / unchecked. More... | |
using | treeSelectionCallback = std::function< bool(TreeView *caller, void *itemData)> |
Used by a nkWinUi::TreeView to signal a selection occurred inside. More... | |
using | listBoxSelectionCallback = std::function< bool(ListBox *caller)> |
Used by a nkWinUi::ListBox to signal a selection occurred inside. More... | |
using | comboSelectionCallback = std::function< bool(ComboBox *caller)> |
Used by a nkWinUi::ComboBox to signal selection changed. More... | |
using | editBoxKeyCallback = std::function< bool(EditBox *caller, const KeyEventData &key)> |
Used by a nkWinUi::EditBox to signal a key has been pressed inside. More... | |
using | tabWindowCallback = std::function< bool(TabWindow *caller, bool changing)> |
Used by a nkWinUi::TabWindow when a tab switch is occurring. More... | |
using | closeCallback = std::function< bool(Component *caller)> |
Used by a component to signal when it's closed. More... | |
using | resizeCallback = std::function< bool(Component *caller)> |
Used by a component upon resize. More... | |
using | contextMenuCreationCallback = std::function< bool(Component *caller, int absX, int absY)> |
Used by components when they need a context menu to be created. More... | |
typedef bool(* | runRoutine) () |
A callback for the running routine. Called when the loop from MainSystem::run() is running. | |
Encompasses all API of component NilkinsWinUi.
This component offers capabilities to create and populate windows from the system UI. Note that currently, only supported system is Windows through the WinAPI.
using nkWinUi::mouseMoveCallback = typedef std::function<bool (Component* caller, int absX, int absY, int relX, int relY, int moveX, int moveY)> |
Used by components for a mouse moved event.
The callback will be called by the component, which will provide all the parameters about the event.
caller | The calling component. |
absX | The mouse x coordinate, absolute, on screen. |
absY | The mouse y coordinate, absolute, on screen. |
relX | The mouse x coordinate, relative to calling component. |
relY | The mouse y coordinate, relative to calling component. |
moveX | The x delta since last mouse moved event. |
moveY | the y delta since last mouse moved event. |
using nkWinUi::mouseClickCallback = typedef std::function<bool (Component* caller, const ClickEventData& eventData)> |
Used by components for a mouse click event.
The callback will be called by the component, which will provide all the parameters about the event.
caller | The calling component. |
eventData | All needed information about the event. |
using nkWinUi::mouseLeaveCallback = typedef std::function<bool (Component* caller, const nkMaths::Point& absCoords)> |
Used by components when the mouse leaves their area.
The callback will be called by the component, which will provide all the parameters about the event.
caller | The calling component. |
absCoords | The absolute coordinates at which the mouse left the component. |
using nkWinUi::keyDownCallback = typedef std::function<bool (Component* caller, KEY_CODE keyCode, bool autoRepeated)> |
Used by component when a keyboard key is pressed down.
The callback will be called by the component, which will provide all the parameters about the event.
caller | The calling component. |
keyCode | The code of the key pushed. |
autoRepeated | Whether this event is fired because the key is being auto repeated (long press). |
using nkWinUi::keyUpCallback = typedef std::function<bool (Component* caller, KEY_CODE keyCode)> |
Used by component when a keyboard key is released.
The callback will be called by the component, which will provide all the parameters about the event.
caller | The calling component. |
The | code of the key released. |
using nkWinUi::menuBarCallback = typedef std::function<bool (Component* caller, int index)> |
Used by a nkWinUi::MenuBar to signal an item has been clicked.
caller | The calling component. |
index | The index attached to the item clicked. |
using nkWinUi::buttonClickCallback = typedef std::function<bool (Button* caller)> |
Used by a nkWinUi::Button to signal it has been clicked.
caller | The calling component. |
using nkWinUi::checkBoxCallback = typedef std::function<bool (CheckBox* caller)> |
Used by a nkWinUi::CheckBox to signal it has been checked / unchecked.
The | calling component. Its state will reflect the new change. |
using nkWinUi::treeSelectionCallback = typedef std::function<bool (TreeView* caller, void* itemData)> |
Used by a nkWinUi::TreeView to signal a selection occurred inside.
caller | The calling component. |
itemData | The user data attached to the item selected. |
using nkWinUi::listBoxSelectionCallback = typedef std::function<bool (ListBox* caller)> |
Used by a nkWinUi::ListBox to signal a selection occurred inside.
caller | The calling component. Its state will reflect the new change. |
using nkWinUi::comboSelectionCallback = typedef std::function<bool (ComboBox* caller)> |
Used by a nkWinUi::ComboBox to signal selection changed.
The | calling component. Its state will reflect the new change. |
using nkWinUi::editBoxKeyCallback = typedef std::function<bool (EditBox* caller, const KeyEventData& key)> |
Used by a nkWinUi::EditBox to signal a key has been pressed inside.
caller | The calling component. |
key | The information about the event. |
using nkWinUi::tabWindowCallback = typedef std::function<bool (TabWindow* caller, bool changing)> |
Used by a nkWinUi::TabWindow when a tab switch is occurring.
caller | The calling component. |
changing | If the tab is being changed, or if it already changed. |
using nkWinUi::closeCallback = typedef std::function<bool (Component* caller)> |
Used by a component to signal when it's closed.
caller | The calling component. |
using nkWinUi::resizeCallback = typedef std::function<bool (Component* caller)> |
Used by a component upon resize.
caller | The calling component. |
using nkWinUi::contextMenuCreationCallback = typedef std::function<bool (Component* caller, int absX, int absY)> |
Used by components when they need a context menu to be created.
caller | The calling component. |
absX | The absolute x position where the menu should be created. |
absY | The absolute y position where the menu should be created. |
|
strong |
Available component types.
Enumerator | |
---|---|
BUTTON | A Button. |
CHECK_BOX | A CheckBox. |
COMBO_BOX | A ComboBox. |
CONTEXT_MENU | A ContextMenu. |
EDIT_BOX | An EditBox. |
FILE_EXPLORER | A FileExplorer. |
GRAPHICS_WINDOW | |
GROUP_BOX | A GroupBox. |
LIST_BOX | A ListBox. |
LOG_WIN | A LogWin. |
MULTI_LINE_EDIT | |
POPUP | A Popup. |
PROGRESS_BAR | A ProgressBar. |
SCROLL_BAR | A ScrollBar. |
SLIDER | A Slider. |
STATIC | A Static. |
TAB_WIN | A TabWindow. |
TREE_VIEW | A TreeView. |
WINDOW | A Window. |
|
strong |
Types of popup available.
Enumerator | |
---|---|
POPUP_TYPE_OK | A simple informative popup with an ok button. |
POPUP_TYPE_OK_CANCEL | A popup requesting for agreement. |
POPUP_TYPE_ABORT_RETRY_IGNORE | A popup requesting if something should be aborted, retried, or ignored. |
POPUP_TYPE_YES_NO_CANCEL | A popup requesting for agreement or cancelling. |
POPUP_TYPE_YES_NO | A popup requesting for agreement. |
POPUP_TYPE_RETRY_CANCEL | A popup asking to retry or cancel. |
POPUP_TYPE_CANCEL_TRY_CONTINUE | A Popup requesting to cancel, try, or continue. |
POPUP_TYPE_HELP | A Popup showing a help tooltip. |
|
strong |
Result answers possible from a popup.
|
strong |
|
strong |
|
strong |
enum nkWinUi::KEY_CODE |
|
strong |
Defines the type of layout available.
Enumerator | |
---|---|
UNKNOWN | A Layout whose type is unknown. Should never be encountered. |
GRID | A grid layout. |
RELATIVE | A relative layout. |
|
strong |
Represents different positions, compared to an anchor.